home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / spitfire / doork10.zip / DOORKNOB.DOC < prev    next >
Text File  |  1992-04-26  |  10KB  |  236 lines
  1.                          ┌──────────────┐
  2.                          │ DOORKNOB.EXE │
  3.                          └──────────────┘
  4.                                  
  5.                   Door or Menu Extension Program
  6.                             Tom Kellen
  7.                    ßETATech Computer Consulting
  8.  
  9. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10.  
  11. PURPOSE:  To provide additional options from a Spitfire BBS menu or
  12.           additional door options for many BBS's. 
  13.  
  14.  
  15.  
  16. INTRODUCTION:
  17.  
  18. DoorKnob provides a way to add more selections to a Spitfire BBS
  19. menu extension or to add to the number of doors a BBS can run.  It
  20. is quite simply, a front end to some batch files that run your
  21. other doors or programs.  DoorKnob provides the menued interface to
  22. these programs and monitors logon time and carrier while it is
  23. active.
  24.  
  25.  
  26.  
  27. INSTALLATION:
  28.  
  29. Create a directory for your menu extension files.  For
  30. documentation purposes we will assume that you are using
  31. C:\SF\DKMAIN.  Copy DOORKNOB.EXE and DOORKNOB.CFG into this
  32. directory.  You will also need to create DOORKNOB.CLR and
  33. DOORKNOB.BBS which are your color and mono menus for DoorKnob (see
  34. the examples enclosed with the program).  You must also place the
  35. batch files that you wish to be accessed from DoorKnob into this
  36. directory.  They should be named A.BAT - Z.BAT.  You can run up to
  37. 25 programs from DoorKnob (Q.BAT is not used and if you enable
  38. logoff via DoorKnob, then G.BAT will also NOT be used).
  39.  
  40. You will need to modify at least 2 lines in DOORKNOB.CFG (on each
  41. line in the configuration file, any text after the ; are considered
  42. comments and ignored).  Here is an example configuration file:
  43.  
  44. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  45. BBS=The Paradigm BBS; Your BBS Name
  46. REGNO=000000; Registration Number, leave as 000000 if unregistered
  47. LOG=C:\LOGS\DOORKNOB.LOG; Log to this file instead of CALLERS.TMP
  48. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  49.  
  50. The first line is the name of your BBS.  This will be displayed as
  51. the door closes and will also be displayed on the main menu once
  52. you register the door.
  53.  
  54. The second line is your registration number.  If you are still
  55. evaluating the door and have not registered, leave this as 000000.
  56.  
  57. The third line is an alternate log file.  By default DoorKnob logs
  58. to CALLERS.TMP for the node that called it so that all information
  59. will be placed in CALLERS.LOG.  If you wish logging for this door
  60. to go elsewhere, add a line like above using the key word LOG=. 
  61. This line is optional and if omitted, all logging will go to your
  62. caller's log.
  63.  
  64. If you don't want to have the beeps the door makes echoed on the
  65. local side (ie. sweet silence mode) then place the key word NOBEEP
  66. on a line in DOORKNOB.CFG.
  67.  
  68. By default the door allows users to log off.  The door will write
  69. this to the log file, but Spitfire may also place a line stating
  70. "Improper return from door...".  This just means that the door
  71. dropped carrier.  If you wish to disable the ability for users to
  72. log off via the door, place the key word NOLOGOFF on a line in your
  73. DOORKNOB.CFG file.
  74.  
  75. In an effort to give the maximum amount of memory possible to the
  76. programs it runs, DoorKnob will swap most of it's code when it runs
  77. a program.  If EMS memory is available, DoorKnob will swap the code
  78. to EMS.  If there is not sufficient EMS available, DoorKnob will
  79. swap it's code to disk.  DoorKnob will look for the environment
  80. variables "TEMP" and "TMP" as these usually point to RAM drives. 
  81. If either of these environment variables exist, DoorKnob's code
  82. will be swapped to the directories specified.  If these variables
  83. don't exist, and there is insufficient EMS, DoorKnob will swap it's
  84. code to the current directory.  There are some cases where you
  85. might not want to take advantage of this code swapping.  If you do
  86. not want to take advantage of DoorKnob's code swapping, add a line
  87. to your DOORKNOB.CFG file that has the key word NOSWAP.  This will
  88. disable swapping when executing a program.
  89.  
  90. The lines in your DOORKNOB.CFG file can be in any order but they
  91. must start with the key words BBS=, REGNO=, LOG=, NOBEEP, NOLOGOFF,
  92. or NOSWAP.  The first 2 are required, the rest are optional.
  93.  
  94. Once you have completed this, you will need to modify your menu
  95. extension BAT to install DoorKnob.  
  96. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  97. @Echo Off
  98. BRK OFF
  99. CD\SF\DK
  100. COPY C:\SF\SFMAIN.DAT
  101. DOORKNOB /DEBUG /DAT=C:\SF /C=C:\SF\DK\DOORKNOB.CFG
  102. ERASE C:\SF\DK\SFMAIN.DAT
  103. CD\SF
  104. BRK ON
  105. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  106.  
  107. This snippet is also included in the distribution ZIP as
  108. SFMAIN.BAT.  Just remember to copy SFMAIN.DAT (or one of the other
  109. SFxxxx.DAT, or DOOR.SYS) to DoorKnob's directory.  DoorKnob needs
  110. this information.  If you are running multiple nodes of Spitfire
  111. you can call DOORKNOB with a /DAT= on the command line indicating
  112. the path to the SFDOORS.DAT file you wish to use.  (ie. DOORKNOB
  113. /DAT=C:\SF01)  When you use /DAT= on the command line you do NOT
  114. have to copy the .DAT file to the DoorKnob directory.  This should
  115. allow multiple nodes to access the same copy of DOORKNOB.EXE.  It
  116. is able to read all of the .DAT files (SFDOORS.DAT, SFMAIN.DAT,
  117. SFMESS.DAT and SFFILE.DAT and DOOR.SYS).  Just make sure you copy
  118. the correct one or indicate the path to the file using /DAT=.
  119.  
  120. Multiple node systems may need to have different configuration
  121. files for different nodes.  If you need this ability, you can
  122. specify a configuration file name on the command line using /C=. 
  123. This parameter requires that you enter the whole path and file name
  124. after the /C= (ie. DOORKNOB /C=C:\SF\DKMAIN\NODE02.CFG).  When you
  125. use /C=, DoorKnob will use the directory specified to look for it's
  126. menu and .BAT files.  This should allow for one copy of
  127. DOORKNOB.EXE to be used for several different extensions and on
  128. multi-node BBS's.
  129.  
  130.  
  131.  
  132. OPERATION:
  133.  
  134. When a user runs DoorKnob, it reads the SFDOORS.DAT file to get
  135. some information needed to run.  It then goes out and get's a list
  136. of all the x.BAT files in it's working directory.  Q.BAT will never
  137. be used as Q is the command to quit back to the BBS.  If you have
  138. enabled logging off via DoorKnob, then G.BAT will also NOT be used
  139. as G will be the command to log off.  If you disable logging off
  140. via the door, then you can create and use a G.BAT file.
  141.  
  142. The menu files for DoorKnob must be named DOORKNOB.CLR and
  143. DOORKNOB.BBS.  The .CLR file is used when a caller has ANSI
  144. enabled, the .BBS is used when ANSI is disabled.  DoorKnob just
  145. displays these files, so you are responsible for making sure that
  146. they match what the .BAT files in the directory do.  DoorKnob's
  147. "Enter Command" prompt will show a list of the available commands
  148. based on the .BAT files it finds.
  149.  
  150. There are sample menu files and batch files included in the
  151. distribution ZIP file.  This is basically the Main Menu extension
  152. that is being run on my Paradigm BBS.
  153.  
  154. When a caller makes a selection, DoorKnob swaps most of it's code
  155. out of memory and runs the batch file selected.  At this point the
  156. program run is in control, and DoorKnob no longer does anything
  157. until that batch file finishes.
  158.  
  159. DoorKnob will log it's transactions to your caller's log for
  160. informational purposes.  If you would like more detailed
  161. information about it's actions, use /DEBUG on the DoorKnob command
  162. line.  This will enable verbose logging.
  163.  
  164. When a user logs off via DoorKnob, it gives them a 10 second count
  165. down where they have the option to hang up immediately or abort
  166. back to DoorKnob.
  167.  
  168. There are several options available to the SysOp.  DoorKnob will
  169. take input from the local side so that if the user needs some help
  170. you can do some typing for them.
  171.  
  172. Hitting the ESC key, will immediately abort the door and send the
  173. user back to the BBS.  You can press F1 and get a short help screen
  174. of the keys available to the SysOp.  Use caution here though, as
  175. input from the user will not be processed while this screen is up
  176. (their keystrokes will be processed as soon as you remove the help
  177. screen).  The help screen has a 10 second time out on it and will
  178. remove its self after that timeout.
  179.  
  180. F6 will give the user an additional 5 minutes of time in the door.
  181.  
  182. F7 will take 5 minutes from the user.  If there is less than 5
  183. minutes left, time will be removed in 1 minute increments.
  184.  
  185. F9 will return the user to the BBS with a message saying that the
  186. SysOp has requested them to return.  F10 will return the user to
  187. the BBS with NO message.
  188.  
  189. DoorKnob is active, it always keeps track of the user's time left
  190. in the door.  DoorKnob also has a 3 minute no keystroke timer.  The
  191. user will be issued messages at 2 min., 1 min. and 30 seconds and
  192. then is logged off.
  193.  
  194.  
  195.  
  196. EPILOGUE:
  197.  
  198. This is a SHAREWARE utility.  The program is NOT crippled and NO
  199. features are disabled.  Sending in the $1.00 US registration fee
  200. with the registration form to the address below will get you a
  201. registration number that will remove the [Unregistered Shareware
  202. Version] message and allow your BBS name to be displayed.
  203.  
  204. Try the door thoroughly until you know in your heart that it is of
  205. use to you, and then send in the registration form and fee.  If it
  206. isn't, please let me know what features might improve the door.
  207.  
  208.  
  209.  
  210. AUTHOR CONTACT:
  211.  
  212. Problems, solutions, kudos and ideas are welcomed.  I can be
  213. reached at the following:
  214.  
  215. The Paradigm BBS                   ßETATech Computer Consulting
  216. 404/671-1581                       P. O. Box 566742
  217. 1200-19,200 Baud 24 Hrs/Day        Atlanta, GA  31156-6013
  218.  
  219.  
  220.  
  221. DISCLAIMER:
  222.  
  223. Use of this program acknowledges this disclaimer of warranty: "This
  224. program is supplied as is.  ßETATech Computer Consulting disclaims
  225. all warranties, express or implied, including, without limitation,
  226. the warranties of merchantability and of fitness of this program
  227. for any purpose.  ßETATech Computer Consulting assumes no liability
  228. for damages direct or consequential, which may result from the use
  229. of this program."
  230.  
  231.  
  232.  
  233. REVISION HISTORY:
  234.  
  235. 26-APR-1992     v1.0    Initial Release
  236.